fix: cut docs version nav from Edge so new pages aren't dropped by lucasgomide · Pull Request #6349 · crewAIInc/crewAI

lucasgomide · 2026-06-26T09:37:57Z

The docs release cut promotes Edge → Latest, but the navigation half of that
promotion read the wrong source. _copy_snapshot correctly copied every
docs/edge/<locale>/ file into docs/v<X.Y.Z>/, while _build_new_entry
registered the new version's docs.json nav by cloning the previous frozen
release and rewriting path prefixes. Any page added to Edge since the last
release was therefore written to disk but never linked in the version
selector. This is why v1.15.0 shipped without the Datadog guide
(enterprise/guides/datadog) in all four locales, even though the files were
present in the snapshot.

Note

Low Risk
Changes are limited to docs-site config and the devtools docs-freeze helper, with no impact on runtime product code.

Overview
Fixes a mismatch in the docs Edge → Latest freeze: file copies already came from docs/edge/, but docs.json navigation for the new version was cloned from the previous frozen release. Pages added to Edge after the last cut (e.g. the Datadog enterprise guide) were copied into the snapshot but missing from the version selector.

crewai_devtools.docs_versioning now builds the new Latest entry from the Edge nav (_edge_entry / _build_new_entry), rewriting paths edge/... → v<X.Y.Z>/.... A regression test covers a page present in Edge but absent from the old frozen nav.

docs/docs.json adds enterprise/guides/datadog under enterprise guides for v1.15.0 and v1.15.1 across en, pt-BR, ko, and ar so those releases expose the guide in the nav.

^{Reviewed by Cursor Bugbot for commit 9fd3c53. Bugbot is set up for automated code reviews on this repo. Configure here.}

Summary by CodeRabbit

New Features
- Added the Datadog enterprise guide to enterprise guides navigation (including new datadog entries) across multiple locales and versions.
Bug Fixes
- Improved documentation version freezing so the Latest/default navigation is cloned from the per-locale Edge content, ensuring new releases link the current Datadog page.
Tests
- Added a regression test verifying new version navigation is sourced from Edge (not a previous snapshot) and that the frozen Datadog MDX page is included.

corridor-security

Summary: This PR updates documentation version navigation generation to clone from the Edge entry and adds corresponding documentation navigation entries/tests. No exploitable security vulnerabilities were identified.

Risk: Low risk. The changes affect documentation metadata and internal release tooling, with no new public attack surface, authentication changes, authorization logic, or sensitive data handling.

coderabbitai · 2026-06-26T09:38:19Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 31766265-bd64-4347-82ca-2608d53376d7

📥 Commits

Reviewing files that changed from the base of the PR and between 7b85bad and 9fd3c53.

📒 Files selected for processing (3)

docs/docs.json
lib/devtools/src/crewai_devtools/docs_versioning.py
lib/devtools/tests/test_docs_versioning.py

🚧 Files skipped from review as they are similar to previous changes (2)

lib/devtools/tests/test_docs_versioning.py
lib/devtools/src/crewai_devtools/docs_versioning.py

📝 Walkthrough

Walkthrough

The docs freeze flow now clones Edge navigation for new versions, rewrites Edge page paths into the frozen version, and updates fixture data and tests for a Datadog Edge page.

Changes

Edge-based docs freeze

Layer / File(s)	Summary
Edge clone logic `lib/devtools/src/crewai_devtools/docs_versioning.py`	Adds `_edge_entry(versions)` and changes `_build_new_entry` to clone Edge navigation while rewriting `edge/<locale>/...` paths into the new version and pruning missing pages.
Migration wiring `lib/devtools/src/crewai_devtools/docs_versioning.py`	Updates `_migrate_docs_json` to source each locale from Edge, skip locale blocks without Edge, and insert the new default entry after Edge.
Datadog fixture and regression `lib/devtools/tests/test_docs_versioning.py`, `docs/docs.json`	Adds `edge/en/datadog.mdx`, extends the Edge guides list, adds Datadog entries to the `v1.15.0` and `v1.15.1` guide lists for en, pt-BR, ko, and ar, and adds a regression test for `v1.15.0/en/datadog`.

Suggested reviewers

gabemilani
vinibrsl

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 55.56% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly reflects the main fix: cloning docs version navigation from Edge so newly added pages are preserved.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch luzk/docs-freeze-from-edge

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

mintlify · 2026-06-26T09:38:27Z

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
crewai	🟢 Ready	View Preview	Jun 26, 2026, 9:50 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

flaviomuniz

LGTM

The docs cut copied every Edge file into the new `docs/v<X.Y.Z>/` snapshot but built that version's `docs.json` navigation by cloning the previous frozen release and only rewriting path prefixes. Pages added to Edge since the last release were therefore copied to disk yet never linked in the version selector, which is why the v1.15.0 cut shipped without the Datadog guide. `_build_new_entry` now clones the Edge nav entry and rewrites `edge/<locale>/` to `v<new>/<locale>/`, so promoting Edge to Latest carries every current page and nav restructuring.

The v1.15.0 freeze copied `enterprise/guides/datadog` into the snapshot for every locale but never linked it in `docs.json`, because the cut cloned the v1.14.7 nav instead of Edge. This backfills the missing nav reference in the `en`, `pt-BR`, `ko`, and `ar` v1.15.0 blocks so the already-shipped page is reachable from the version selector. Pairs with the `_build_new_entry` fix that prevents future cuts from dropping pages.

The v1.15.1 cut ran before the freeze-from-Edge fix landed, so it inherited the same bug as v1.15.0: `enterprise/guides/datadog` was copied into the snapshot for every locale but never linked in `docs.json`. This backfills the missing nav reference in the `en`, `pt-BR`, `ko`, and `ar` v1.15.1 blocks so the page is reachable from the version selector.

corridor-security Bot reviewed Jun 26, 2026

View reviewed changes

github-actions Bot added the size/S label Jun 26, 2026

mintlify Bot deployed to staging - docs June 26, 2026 09:50 View deployment

lucasgomide force-pushed the luzk/docs-freeze-from-edge branch from 0ff2316 to e15f5fe Compare June 26, 2026 09:58

mintlify Bot deployed to staging - docs June 26, 2026 10:08 View deployment

flaviomuniz approved these changes Jun 29, 2026

View reviewed changes

mintlify Bot deployed to staging - docs June 29, 2026 12:49 View deployment

lucasgomide added 3 commits June 29, 2026 10:47

lucasgomide force-pushed the luzk/docs-freeze-from-edge branch from 7b85bad to 9fd3c53 Compare June 29, 2026 13:49

flaviomuniz approved these changes Jun 29, 2026

View reviewed changes

mintlify Bot deployed to staging - docs June 29, 2026 14:00 View deployment

lucasgomide merged commit 2b87098 into main Jun 29, 2026
58 checks passed

lucasgomide deleted the luzk/docs-freeze-from-edge branch June 29, 2026 14:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: cut docs version nav from Edge so new pages aren't dropped#6349

fix: cut docs version nav from Edge so new pages aren't dropped#6349
lucasgomide merged 3 commits into
mainfrom
luzk/docs-freeze-from-edge

lucasgomide commented Jun 26, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

corridor-security Bot left a comment

Uh oh!

coderabbitai Bot commented Jun 26, 2026 •

edited

Loading

Walkthrough

Changes

Suggested reviewers

❌ Failed checks (1 warning)

Uh oh!

mintlify Bot commented Jun 26, 2026 •

edited

Loading

Uh oh!

flaviomuniz left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

lucasgomide commented Jun 26, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

corridor-security Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Suggested reviewers

❌ Failed checks (1 warning)

Uh oh!

mintlify Bot commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

flaviomuniz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lucasgomide commented Jun 26, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 26, 2026 •

edited

Loading

mintlify Bot commented Jun 26, 2026 •

edited

Loading